add resolveDid #6

insipx · 2023-12-12T22:09:30Z

closes #4

Not implementing for this PR

blockTag for DID

Example

Run against Sepolia with RUST_LOG=didethresolver=debug ./target/release/didethresolver -p "wss://ethereum-sepolia.publicnode.com"

example query:
❯ curl -H "Content-Type: application/json" -d '{"id":1, "jsonrpc":"2.0", "method": "did_resolveDid", "params": ["0x423B6F365C14F4b233928088FF937e01c143A328"]}' http://localhost:9944

Pretty print the result:
❯ curl -H "Content-Type: application/json" -d '{"id":1, "jsonrpc":"2.0", "method": "did_resolveDid", "params": ["0x423B6F365C14F4b233928088FF937e01c143A328"]}' http://localhost:9944 | jq .result

insipx · 2023-12-12T22:23:33Z

src/types/did_url.rs

@@ -0,0 +1,223 @@
+//! Convenience Wrapper around [`Url`] for DID URIs according to the [DID Spec](https://www.w3.org/TR/did-core/#did-syntax)


This works well but the url crate is based on the whatwg standard

Ideally we find a crate that already implemented the standard DID is a derivative of, or we can just use regex like did-ethr reference implementation. It seems to me that the url crate is more flexible than regex, though, and we get queries + fragments for free. We just need to impl id parsing ourselves (separate network id and address) which isn't a big ask, and could use regex for.

jac18281828

This looks like a pretty good start! I hit a few snags because the tests dont appear to build and there are a few warnings outstanding.

This project may be helpful: https://github.com/OwnYourData/didlint

It appears there is a network api as well.

insipx · 2023-12-13T17:33:15Z

This looks like a pretty good start! I hit a few snags because the tests dont appear to build and there are a few warnings outstanding.

This project may be helpful: https://github.com/OwnYourData/didlint

It appears there is a network api as well.

thanks! Definitely cleanup to do and still working on generating the actual did document from the did history. There is a network endpoint, did_resolveDid that can be called:

curl -H "Content-Type: application/json" -d '{"id":1, "jsonrpc":"2.0", "method": "did_resolveDid", "params": ["0x6CEb0bF1f28ca4165d5C0A04f61DC733987eD6ad"]}' http://localhost:9944/ | jq .result

After starting with cargo run --release -- p "wss://ethereum-spolia.publicnode.com" (need to change to env variables)

but currently only returns a stub did document until wrap_did_document is finished, although it does log the event history if you run the server with RUST_LOG=didethresolver=debug.

The tests don't build because i haven't updated the with_client harness yet. It requires starting a eth server now which can be done in-code with Foundry, but maybe should be moved to integration tests. While I get the first iteration of wrap_did_document finished i'm just testing against the already-deployed sepolia contract and server

I'll also make sure to test everything with did-lint. In the future, it would be nice to have did-lint run automatically on CI push against Sepolia to verify our documents

insipx · 2023-12-20T21:53:51Z

This could use some more tests, but overall I feel like it's in a pretty good place. I'll create a ticket for the cases I'd like to create tests for

insipx · 2023-12-20T23:53:12Z

src/main.rs

+use didethresolver::run;
+
+#[tokio::main]
+async fn main() -> Result<()> {


This separation of a main and lib is done to make integration testing possible

…olveDid

codecov-commenter · 2023-12-22T22:24:22Z

Codecov Report

Attention: 97 lines in your changes are missing coverage. Please review.

Comparison is base (ed3cedb) 91.37% compared to head (19d0af0) 91.62%.

Files	Patch %	Lines
src/types/ethr.rs	95.00%	25 Missing ⚠️
src/lib.rs	0.00%	15 Missing ⚠️
src/types.rs	87.50%	15 Missing ⚠️
src/types/did_url.rs	91.30%	12 Missing ⚠️
src/rpc/methods.rs	54.54%	10 Missing ⚠️
src/util.rs	40.00%	6 Missing ⚠️
src/types/did_parser.rs	98.10%	5 Missing ⚠️
src/resolver/did_registry.rs	80.00%	4 Missing ⚠️
src/main.rs	0.00%	3 Missing ⚠️
src/resolver.rs	97.50%	2 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main       #6      +/-   ##
==========================================
+ Coverage   91.37%   91.62%   +0.24%     
==========================================
  Files           5       11       +6     
  Lines          58     1182    +1124     
==========================================
+ Hits           53     1083    +1030     
- Misses          5       99      +94

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

jac18281828

Thank you for adding tests and documentation! This is great work and a great start. Please add a ticket to support handling for revoked attributes as that is somewhat important

jac18281828 · 2024-01-02T17:31:33Z

example.env

@@ -0,0 +1,2 @@
+ADDRESS="127.0.0.1:9944"


I believe these quotes are not required in this context. I believe in the TypeScript dotenv these quotes will be included in the environment, not sure how rust behaves but its worth checking

jac18281828 · 2024-01-02T17:33:08Z

src/lib.rs

+// so it could be worth defining a config file that maps chainId to RPC provider (like
+// did-eth-resolver)
+/// The address of the DID Registry contract on the Ethereum Sepolia Testnet
+pub const DID_ETH_REGISTRY: &str = "0xd1D374DDE031075157fDb64536eF5cC13Ae75000";


This will be a proxy contract with a stable address on all networks. Allowing override probably makes sense, but may also create a security loophole.

we should be explicit that the override is only for tests, or restrict overriding the tests only when we're sure we're in a test environment

jac18281828 · 2024-01-02T17:33:47Z

src/main.rs

+use didethresolver::run;
+
+#[tokio::main]
+async fn main() -> Result<()> {


jac18281828 · 2024-01-02T17:36:27Z

src/resolver.rs

+        Ok(self.wrap_did_document(public_key, history).await?)
+    }
+
+    async fn changelog(&self, public_key: H160) -> Result<Vec<(DIDRegistryEvents, LogMeta)>> {


Are we handing revoked an expired events? If that is not part of this change please make sure we open an issue on that before this gets merged.

it should handle these events in the wrap_did_document method, although we should definitely make sure of it and add tests specifically for revoked attributes, added a ticket here

insipx added 7 commits December 11, 2023 17:34

incorporate contract,resolver, and create did-url

4fe4525

try to incorporate network and address parsing into did url

ee73997

tests for address and network

0b3da61

create history of DID events

c5059fb

comment

ce50b03

fix some comments

7ff973c

dont need to specify address

ca81018

insipx commented Dec 12, 2023

View reviewed changes

insipx changed the title ~~add resolveDID functionality~~ add resolveDid Dec 12, 2023

jac18281828 reviewed Dec 13, 2023

View reviewed changes

insipx added 6 commits December 13, 2023 17:42

parsing events, updated gpg keys

8f70bb6

refactor to make document logic clearer to follow

73e5d05

remove unused

bae9ee2

ethr builder, docs tests

b046108

tests

08b623f

revert

159eec7

insipx linked an issue Dec 20, 2023 that may be closed by this pull request

Endpoint: 'resolveDid' #4

Closed

insipx self-assigned this Dec 20, 2023

insipx added 3 commits December 20, 2023 14:48

integration testing

25d7b3d

integration tests and fmt

47b225a

history.reverse() to read events in the right order

b5fe46d

insipx marked this pull request as ready for review December 20, 2023 21:53

insipx added 3 commits December 20, 2023 16:56

docs

38b4fd3

fixes and more docs

86bae60

doc

94354eb

insipx commented Dec 20, 2023

View reviewed changes

insipx added 2 commits December 20, 2023 18:53

remove spurious newline

1a46a8d

add some light error handling

115fd4e

insipx added 8 commits December 21, 2023 13:31

0x for blockchain_account_id

86db1f0

remove some unwraps and polish error reporting

1d82d56

warnings

51aba6b

more docs

54e7e8f

doc typos

80c3bca

add pkg-config openssl libssl-dev to dockerbuild

dfcb108

fix anvil spawn

ca370b2

Merge branch 'main' of github.com:xmtp/didethresolver into insipx/res…

e4da0c8

…olveDid

insipx and others added 3 commits December 22, 2023 17:53

a quick test

19d0af0

Use Environment Variables instead of CLI Arguments (#18)

02adc57

fmt

381674b

tsachiherman approved these changes Jan 2, 2024

View reviewed changes

jac18281828 approved these changes Jan 2, 2024

View reviewed changes

tsachiherman mentioned this pull request Jan 2, 2024

Add version_id support #21

Merged

insipx merged commit aa7b8d7 into main Jan 3, 2024
3 checks passed

37ng deleted the insipx/resolveDid branch January 5, 2024 23:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add resolveDid #6

add resolveDid #6

insipx commented Dec 12, 2023 •

edited by jac18281828

Loading

insipx Dec 12, 2023 •

edited

Loading

jac18281828 left a comment

insipx commented Dec 13, 2023 •

edited

Loading

insipx commented Dec 20, 2023

insipx Dec 20, 2023 •

edited

Loading

jac18281828 Jan 2, 2024

codecov-commenter commented Dec 22, 2023 •

edited

Loading

jac18281828 left a comment

jac18281828 Jan 2, 2024

jac18281828 Jan 2, 2024

insipx Jan 3, 2024

jac18281828 Jan 2, 2024

jac18281828 Jan 2, 2024

insipx Jan 3, 2024 •

edited

Loading

		@@ -0,0 +1,223 @@
		//! Convenience Wrapper around [`Url`] for DID URIs according to the [DID Spec](https://www.w3.org/TR/did-core/#did-syntax)

add resolveDid #6

add resolveDid #6

Conversation

insipx commented Dec 12, 2023 • edited by jac18281828 Loading

Example

insipx Dec 12, 2023 • edited Loading

Choose a reason for hiding this comment

jac18281828 left a comment

Choose a reason for hiding this comment

insipx commented Dec 13, 2023 • edited Loading

insipx commented Dec 20, 2023

insipx Dec 20, 2023 • edited Loading

Choose a reason for hiding this comment

jac18281828 Jan 2, 2024

Choose a reason for hiding this comment

codecov-commenter commented Dec 22, 2023 • edited Loading

Codecov Report

jac18281828 left a comment

Choose a reason for hiding this comment

jac18281828 Jan 2, 2024

Choose a reason for hiding this comment

jac18281828 Jan 2, 2024

Choose a reason for hiding this comment

insipx Jan 3, 2024

Choose a reason for hiding this comment

jac18281828 Jan 2, 2024

Choose a reason for hiding this comment

jac18281828 Jan 2, 2024

Choose a reason for hiding this comment

insipx Jan 3, 2024 • edited Loading

Choose a reason for hiding this comment

insipx commented Dec 12, 2023 •

edited by jac18281828

Loading

insipx Dec 12, 2023 •

edited

Loading

insipx commented Dec 13, 2023 •

edited

Loading

insipx Dec 20, 2023 •

edited

Loading

codecov-commenter commented Dec 22, 2023 •

edited

Loading

insipx Jan 3, 2024 •

edited

Loading